ApplyFixedValuesFilter(Int32,Boolean,IEnumerable<String>) Method

Applies a FixedValuesFilter to the column.

Syntax

Visual Basic

'Declaration
 
Public Overloads Function ApplyFixedValuesFilter( _
   ByVal relativeColumnIndex As Integer, _
   ByVal includeBlanks As Boolean, _
   ByVal displayValues As IEnumerable(Of String) _
) As FixedValuesFilter

C#

public FixedValuesFilter ApplyFixedValuesFilter( 
   int relativeColumnIndex,
   bool includeBlanks,
   IEnumerable<string> displayValues
)

Parameters

relativeColumnIndex

A zero based column index relative to the Region

includeBlanks

The value which indicates whether blank cells should be filtered in.

displayValues

The collection of case-insensitively unique cell text values which should be filtered in.

Exceptions

Exception	Description
System.ArgumentNullException	displayValues is null.
System.ArgumentNullException	A value in the displayValues collection is null.
System.ArgumentException	Multiple values from the displayValues collection are case-insensitively equal.
System.InvalidOperationException	includeBlanks is False and displayValues has no items. At least one value must be allowed.
System.InvalidOperationException	If the Region was not set.
System.ArgumentOutOfRangeException	If the relativeColumnIndex is outside of the Region.

Remarks

Note: If any text values are longer than 255 characters in length and the workbook is saved in one of the 2003 formats, the correct rows will be hidden in the saved file, but the filter may be missing from the column or reapplying the filter may hide some of the matching cells.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2